home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3c / mbstring.z / mbstring
Encoding:
Text File  |  1998-10-20  |  7.5 KB  |  133 lines

  1.  
  2.  
  3.  
  4. mmmmbbbbssssttttrrrriiiinnnngggg((((3333CCCC))))                                                      mmmmbbbbssssttttrrrriiiinnnngggg((((3333CCCC))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _mmmm_bbbb_ssss_tttt_rrrr_iiii_nnnn_gggg: _mmmm_bbbb_ssss_tttt_oooo_wwww_cccc_ssss, _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss, _wwww_cccc_ssss_xxxx_ffff_rrrr_mmmm - multibyte string functions
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_tttt_dddd_llll_iiii_bbbb_...._hhhh_>>>>
  13.      _ssss_iiii_zzzz_eeee______tttt _mmmm_bbbb_ssss_tttt_oooo_wwww_cccc_ssss _((((_wwww_cccc_hhhh_aaaa_rrrr______tttt _****_pppp_wwww_cccc_ssss_,,,, _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_ssss_,,,, _ssss_iiii_zzzz_eeee______tttt _nnnn_))))_;;;;
  14.      _ssss_iiii_zzzz_eeee______tttt _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss _((((_cccc_hhhh_aaaa_rrrr _****_ssss_,,,, _cccc_oooo_nnnn_ssss_tttt _wwww_cccc_hhhh_aaaa_rrrr______tttt _****_pppp_wwww_cccc_ssss_,,,, _ssss_iiii_zzzz_eeee______tttt _nnnn_))))_;;;;
  15.  
  16.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_wwww_cccc_hhhh_aaaa_rrrr_...._hhhh_>>>>
  17.      _ssss_iiii_zzzz_eeee______tttt _wwww_cccc_ssss_xxxx_ffff_rrrr_mmmm _((((_wwww_cccc_hhhh_aaaa_rrrr______tttt _****_wwww_ssss_1111_,,,, _cccc_oooo_nnnn_ssss_tttt _wwww_cccc_hhhh_aaaa_rrrr______tttt _****_wwww_ssss_2222_,,,, _ssss_iiii_zzzz_eeee______tttt _nnnn_))))_;;;;
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      _mmmm_bbbb_ssss_tttt_oooo_wwww_cccc_ssss converts a sequence of multibyte characters from the array
  21.      pointed to by _s into a sequence of corresponding wide character codes and
  22.      stores these codes into the array pointed to by _p_w_c_s, stopping after _n
  23.      codes are stored or a code with value zero (a converted null character)
  24.      is stored.  If _p_w_c_s is a null pointer, _mmmm_bbbb_ssss_tttt_oooo_wwww_cccc_ssss returns the length
  25.      required to convert the entire array regardless of the value of _n, but no
  26.      values are stored.
  27.  
  28.      _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss converts a sequence of wide character codes from the array
  29.      pointed to by _p_w_c_s into a sequence of multibyte characters and stores
  30.      these multibyte characters into the array pointed to by _s, stopping if a
  31.      multibyte character would exceed the limit of _n total bytes or if a null
  32.      character is stored.  If _s is a null pointer, _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss returns the length
  33.      required to convert the entire array regardless of the value of _n, but no
  34.      values are stored.  This function returns the number of bytes required
  35.      for the character array.
  36.  
  37.      _wwww_cccc_ssss_xxxx_ffff_rrrr_mmmm  transforms the wide character string pointed to by _w_s_2 and
  38.      places the resulting wide character string into the array pointed to by
  39.      _w_s_1 . The transformation is such that if _wwww_cccc_ssss_cccc_mmmm_pppp is applied to two
  40.      transformed wide strings, it returns a value greater than, equal to or
  41.      less than _0000, corresponding to the result of _wwww_cccc_ssss_cccc_oooo_llll_llll applied to the same
  42.      two original wide character strings.  No more than _n wide-character codes
  43.      are placed into the resulting array pointed to by _w_s_1 , including the
  44.      terminating null wide-character code.  If _n is _0000, _w_s_1 is permitted to be
  45.      a null pointer.  If copying takes place between objects that overlap, the
  46.      behaviour is undefined.  _wwww_cccc_ssss_xxxx_ffff_rrrr_mmmm returns the length of the transformed
  47.      wide character string (not including the terminating null wide-character
  48.      code). If the value returned is _n or more, the contents of the array
  49.      pointed to by _w_s_1 are indeterminate.
  50.  
  51. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  52.      _wwww_cccc_hhhh_rrrr_tttt_bbbb_llll(1M), _mmmm_bbbb_cccc_hhhh_aaaa_rrrr(3C), _ssss_eeee_tttt_llll_oooo_cccc_aaaa_llll_eeee(3C), _wwww_cccc_ssss_cccc_mmmm_pppp(3S), _wwww_cccc_ssss_cccc_oooo_llll_llll(3S),
  53.      _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5), _<<<<_wwww_cccc_hhhh_aaaa_rrrr_...._hhhh_>>>>.
  54.  
  55. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  56.      If an invalid multibyte character is encountered, _mmmm_bbbb_ssss_tttt_oooo_wwww_cccc_ssss returns
  57.      (_ssss_iiii_zzzz_eeee______tttt)-1 with _eeee_rrrr_rrrr_nnnn_oooo set equal to _EEEE_IIII_LLLL_SSSS_EEEE_QQQQ.  Otherwise, _mmmm_bbbb_ssss_tttt_oooo_wwww_cccc_ssss returns
  58.      the number of array elements modified, not including the terminating zero
  59.      code, if any.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. mmmmbbbbssssttttrrrriiiinnnngggg((((3333CCCC))))                                                      mmmmbbbbssssttttrrrriiiinnnngggg((((3333CCCC))))
  71.  
  72.  
  73.  
  74.      If a wide character code is encountered that does not correspond to a
  75.      valid multibyte character, _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss returns (_ssss_iiii_zzzz_eeee______tttt)-1 with _eeee_rrrr_rrrr_nnnn_oooo set
  76.      equal to _EEEE_IIII_LLLL_SSSS_EEEE_QQQQ.  Otherwise, _wwww_cccc_ssss_tttt_oooo_mmmm_bbbb_ssss returns the number of bytes
  77.      modified, not including a terminating null character, if any.
  78.  
  79.      On error, _wwww_cccc_ssss_xxxx_ffff_rrrr_mmmm returns _((((_ssss_iiii_zzzz_eeee______tttt_))))_----_1111 and sets _eeee_rrrr_rrrr_nnnn_oooo to indicate the
  80.      error.  If the  wide character string pointed to by _w_s_2 contains wide-
  81.      character codes outside the domain of the collating sequence, then _eeee_rrrr_rrrr_nnnn_oooo
  82.      is set to _EEEE_IIII_NNNN_VVVV_AAAA_LLLL.
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.